Export: Flow-Cal Ticket Data TFX
Note: This command is provided as an optional feature. For this command to function, several requirements must be met.
If installed, Export: Flow-Cal Ticket Data TFX (EXPTFX via script) is the command that triggers the service to export raw ticket data records for a defined time range from FMS to Flow-Cal as a .tfx file. Data that is not from a raw data source, e.g. has been imported into FMS via .csv files (categorized as a "User file" source), is not included in the export.
When the Export: Flow-Cal Ticket Data TFX command is executed, ticket data is resolved for each eligible device via the customizable CDF, and the FMS Service exports the raw data records, created within the specified command time window, to the specified directory location as a .tfx file.
You must have proper security authorization to execute this command. See FMS Security (and CMDDEV security event) for information about configuring security access for FMS commands.
See Configuring Export: Flow-Cal Ticket Data TFX Commands and Running Node Commands for more information about using this command via FMS Explorer.
See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.
See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.
See CxFms for more information about scripting commands.
Command Requirements
To enable the command to export raw data to Flow-Cal .tfx files, and see the command listed in command management options, the following elements must be present.
- Flow-Cal Export DLL — CygNet Measurement provides an optional DLL file that must be installed on your system to support data exports from FMS to Flow-Cal. The file (CxFmsFlowCalExport.dll) must be installed and registered in the CygNet\Support folder on the computer hosting your FMS. See Installing CygNet Measurement for more information about installation and registration of the export DLL file.
- Flow-Cal Export CDF — CygNet Measurement provides a command definition file (CDF) that must be installed on your system to define how your raw ticket data is exported from FMS to Flow-Cal .tfx files. The CDF contains the data item mappings and actions necessary to execute the export command to the corresponding Flow-Cal file version and type, and can be customized to define how the data items are handled. The specific CDF file (ExportFlowCalTicket.cdf) must be included in the CygNet\Services\FMS\CommandDefs folder on your host server. See Installing CygNet Measurement for more information about installation and registration of the export CDF file. See Editing or Customizing the Command Definition File for more information about using and modifying the CDF file.
Note: Refer to Flow-Cal documentation and/or contact your Flow-Cal representative for the most current information about differences between TFX versions, and specific Flow-Cal configuration details.
Command Definition Properties
The following command definition properties apply to Export: Flow-Cal Ticket Data TFX commands, when scheduling, creating, or editing commands via CygNet Explorer.
| Property | Description |
|---|---|
|
FMS service |
Select a Site.Service for the command from the available FMS service list in the drop-down menu. |
|
Command |
Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types. |
|
Priority |
Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows.
Default value is Low level processing queue priority. |
|
Logging |
Select a Logging level for the command results from the drop-down menu. Options are as follows.
Default value is Low level logging when scheduling a command via the MSS in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS in CygNet Explorer. |
Command Parameters
The following command parameters apply to Export: Flow-Cal Ticket Data TFX commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.
| Parameter | Description | Type | Usage Notes |
|---|---|---|---|
|
ExStDate |
Start date/time |
DateTime |
Double-click to access the Select Start Date/Time dialog box. Select the starting date and time of the range for which to export records. See Selecting Date and Time for more information. See Note below this table. This parameter is required. |
|
ExEndDate |
End date/time |
DateTime |
Double-click to access the Select End Date/Time dialog box. Select the ending date and time of the range for which to export records. See Selecting Date and Time for more information. See Note below this table. This parameter is required. |
|
ExPath |
Directory to export file |
File Directory |
Double-click to access the Enter Directory to Export File dialog box. Type the directory location for the file into the text box or click ... to access the Browse for Folder dialog box, browse to the directory location, and then click OK. Notes: For exports via the MSS in CygNet Explorer, the directory specified is relative to the host computer for your FMS. For exports via script, or when using a <Quick Command> via the FMS in CygNet Explorer, or via the FMS Explorer, the directory specified is relative to your client computer. This parameter is required. |
|
ExDirFmt |
Export directory format |
String Enum |
Double-click to access the Export Directory Format dialog box. Select a file directory format for the .tfx export file, from the options in the drop-down menu. Options are as follows.
This parameter is required. |
|
ExFileNm |
Name of export file |
String Enum |
Double-click to access the Name of Export File dialog box. Select a file name format for the .tfx export file. Options are as follows.
This parameter is required. |
|
ExProdReq |
Product data requirement |
String Enum |
For liquid product data, double-click to access the Product Data Requirement dialog box. Select whether to export product data, from the options in the drop-down menu. Options are as follows.
This parameter is required. |
|
ExFileVer |
File format version |
String Enum |
Double-click to access the File Format Version dialog box. Select the version of the .tfx file created for the export, from the options in the drop-down menu. Options are as follows.
Note: Alternatively, file format version can be configured in the .cdf (command definition file) if desired. This parameter is required. |
|
ExDtExFlg |
Data exported flag |
String Enum |
Note: When this command is executed via a Business Slave FMS service, only the "Ignore flag" option is available for this parameter. Double-click to access the Data Exported Flag dialog box. From the options in the drop-down menu, select whether or not to use the flag to mark exported device records in the database. Options are as follows.
This parameter is required. |
Note: When using relative (rather than absolute) date/time, if both the start and end date/time have hour, minute, and second values of 00, or if both are set to midnight, an additional day will be added to the date at the end of the range. This occurs because the service assumes the start of the day for the starting date/time and the end of the day for the ending date/time in these circumstances. Therefore requesting a time range from T to T will yield one day of data, and from T-1 to T will yield two days of data. If only one day of data is desired when using relative date/time, the start and end date/times must therefore be the same. If any of the start or end date/time hour, minute, or second values are specified as a value other than zero (or midnight) however, the range will be used as specified.
